<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Save EJAM results in a spreadsheet — ejam2excel • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Save EJAM results in a spreadsheet — ejam2excel"><meta name="description" content="ejam2excel() takes the output of something like ejamit() and
creates a spreadsheet with an overall summary tab, a site by site table tab,
as well as other tabs such as map, plot, notes, etc."><meta property="og:description" content="ejam2excel() takes the output of something like ejamit() and
creates a spreadsheet with an overall summary tab, a site by site table tab,
as well as other tabs such as map, plot, notes, etc."><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Save EJAM results in a spreadsheet</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/ejam2excel.R" class="external-link"><code>R/ejam2excel.R</code></a></small>
      <div class="d-none name"><code>ejam2excel.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>ejam2excel() takes the output of something like ejamit() and
creates a spreadsheet with an overall summary tab, a site by site table tab,
as well as other tabs such as map, plot, notes, etc.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ejam2excel</span><span class="op">(</span></span>
<span>  <span class="va">ejamitout</span>,</span>
<span>  fname <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  save_now <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  overwrite <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  launchexcel <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  interactive_console <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  ok2plot <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  in.testing <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  in.analysis_title <span class="op">=</span> <span class="st">"EJAM analysis"</span>,</span>
<span>  react.v1_summary_plot <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  radius_or_buffer_in_miles <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  buffer_desc <span class="op">=</span> <span class="st">"Selected Locations"</span>,</span>
<span>  radius_or_buffer_description <span class="op">=</span></span>
<span>    <span class="st">"Miles radius of circular buffer (or distance used if buffering around polygons)"</span>,</span>
<span>  hyperlink_colnames <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"EJScreen Report"</span>, <span class="st">"EJScreen Map"</span>, <span class="st">"ECHO report"</span><span class="op">)</span>,</span>
<span>  site_method <span class="op">=</span> <span class="st">""</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-ejamitout">ejamitout<a class="anchor" aria-label="anchor" href="#arg-ejamitout"></a></dt>
<dd><p>output of <code><a href="ejamit.html">ejamit()</a></code></p></dd>


<dt id="arg-fname">fname<a class="anchor" aria-label="anchor" href="#arg-fname"></a></dt>
<dd><p>optional name or full path and name of file to save locally, like "out.xlsx"</p></dd>


<dt id="arg-save-now">save_now<a class="anchor" aria-label="anchor" href="#arg-save-now"></a></dt>
<dd><p>optional logical, whether to save as a .xlsx file locally or just return workbook object
that can later be written to .xlsx file using <code><a href="https://rdrr.io/pkg/openxlsx/man/saveWorkbook.html" class="external-link">openxlsx::saveWorkbook()</a></code></p></dd>


<dt id="arg-overwrite">overwrite<a class="anchor" aria-label="anchor" href="#arg-overwrite"></a></dt>
<dd><p>optional logical, passed to <code><a href="https://rdrr.io/pkg/openxlsx/man/saveWorkbook.html" class="external-link">openxlsx::saveWorkbook()</a></code></p></dd>


<dt id="arg-launchexcel">launchexcel<a class="anchor" aria-label="anchor" href="#arg-launchexcel"></a></dt>
<dd><p>optional logical, passed to <code><a href="table_xls_format.html">table_xls_format()</a></code>, whether to launch browser to see spreadsheet immediately</p></dd>


<dt id="arg-interactive-console">interactive_console<a class="anchor" aria-label="anchor" href="#arg-interactive-console"></a></dt>
<dd><p>optional - should set to FALSE when used in code or server. If TRUE,
prompts RStudio user interactively asking where to save the downloaded file</p></dd>


<dt id="arg-ok-plot">ok2plot<a class="anchor" aria-label="anchor" href="#arg-ok-plot"></a></dt>
<dd><p>optional logical, passed to  <code><a href="table_xls_format.html">table_xls_format()</a></code>, whether safe to try and plot or set FALSE if debugging plot problems</p></dd>


<dt id="arg-in-testing">in.testing<a class="anchor" aria-label="anchor" href="#arg-in-testing"></a></dt>
<dd><p>optional logical</p></dd>


<dt id="arg-in-analysis-title">in.analysis_title<a class="anchor" aria-label="anchor" href="#arg-in-analysis-title"></a></dt>
<dd><p>optional title as character string</p></dd>


<dt id="arg-react-v-summary-plot">react.v1_summary_plot<a class="anchor" aria-label="anchor" href="#arg-react-v-summary-plot"></a></dt>
<dd><p>optional - a plot object</p></dd>


<dt id="arg-radius-or-buffer-in-miles">radius_or_buffer_in_miles<a class="anchor" aria-label="anchor" href="#arg-radius-or-buffer-in-miles"></a></dt>
<dd><p>optional radius in miles</p></dd>


<dt id="arg-buffer-desc">buffer_desc<a class="anchor" aria-label="anchor" href="#arg-buffer-desc"></a></dt>
<dd><p>description of location to use in labels, like "Selected Locations"</p></dd>


<dt id="arg-radius-or-buffer-description">radius_or_buffer_description<a class="anchor" aria-label="anchor" href="#arg-radius-or-buffer-description"></a></dt>
<dd><p>optional text phrase describing places analyzed</p></dd>


<dt id="arg-hyperlink-colnames">hyperlink_colnames<a class="anchor" aria-label="anchor" href="#arg-hyperlink-colnames"></a></dt>
<dd><p>optional names of columns with URLs</p></dd>


<dt id="arg-site-method">site_method<a class="anchor" aria-label="anchor" href="#arg-site-method"></a></dt>
<dd><p>site selection method, such as NAICS, FRS, SHP, latlon,
optional site method parameter used to create a more specific title with create_filename</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>optional additional parameters passed to <code><a href="table_xls_format.html">table_xls_format()</a></code>, such as
heatmap_colnames, heatmap_cuts, heatmap_colors, etc.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>returns a workbook object for use by openxlsx::saveWorkbook(wb_out, pathname)
or returns just the full path/file name of where it was saved if save_now = TRUE</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span><span class="co"># Add purple to flag indicators at 99th percentile</span></span>
<span><span class="fu">ejam2excel</span><span class="op">(</span><span class="va">testoutput_ejamit_10pts_1miles</span>, </span>
<span>  <span class="co"># View spreadsheet 1st without saving it as a file</span></span>
<span>  launchexcel <span class="op">=</span> <span class="cn">T</span>, save_now <span class="op">=</span> <span class="cn">F</span>, </span>
<span>  heatmap_cuts <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">80</span>, <span class="fl">90</span>, <span class="fl">95</span>, <span class="fl">99</span><span class="op">)</span>, </span>
<span>  heatmap_colors  <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"yellow"</span>, <span class="st">"orange"</span>, <span class="st">"red"</span>, <span class="st">"purple"</span><span class="op">)</span>, </span>
<span>  <span class="co"># Apply heatmap to only a few of the ratio columns</span></span>
<span>  heatmap2_colnames <span class="op">=</span> <span class="va">names_d_ratio_to_state_avg</span><span class="op">)</span></span>
<span><span class="op">}</span> <span class="co"># }</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2025</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

